home *** CD-ROM | disk | FTP | other *** search
/ Acorn User: China / Acorn User China CD-ROM (UK) (Disc A) / Acorn User China CD-ROM (UK) (Disc A).bin / DEMON / DEVELOPER / AUTOUUD.ARC / !AutoUUD_!Help < prev    next >
Encoding:
Text File  |  1996-03-08  |  8.6 KB  |  272 lines
  1.  
  2.                 !AutoUUD
  3.                 --------
  4.                 
  5.     An Automatic Binary extractor for !Newsbase v0.55 and above.
  6.  
  7. Author: © James Beech 95-96            v1.00ß (08-Mar-96) FREEWARE
  8. ----------------------------------------------------------------------------
  9.  
  10. Note: If you are using !Edit to read this, then click on 'Expand Tabs' to
  11. turn all those [09]'s into something useful.
  12.  
  13.  
  14. Contents
  15. --------
  16.  
  17. 1)    Introduction
  18. 2)    System Requirements
  19. 3)    Installing AutoUUD
  20. 4)    Loading/Configuration
  21. 5)    Debatching (AutoUUD in use)
  22. 6)    Removing AutoUUD (DeInstallation)
  23. 7)    Known Bugs/Limitations (FAQ)
  24. 8)    History/Changes
  25. 9)    Wish list (Future updates)
  26. 10)    Contacting Me
  27. 11)     ATTN: GRAPHICS ARTISTS!
  28.  
  29.  
  30.  
  31. Introduction
  32. ------------
  33.  
  34. AutoUUD is an automatic binary decoder. This is only really useful if you
  35. read news or email from the internet, although as a general rule, if
  36. NewsBase+TTFN can handle it, then AutoUUD should as well.
  37.  
  38. Where AutoUUD really comes into it's own is when you subscribe to a Usenet
  39. news group that carries a lot of encoded binaries, some of them split into
  40. several messages. (eg 'alt.binaries.sounds.mods')
  41. After you have grabbed your news, just run AutoUUD and all the messages that
  42. hold binaries will be decoded into a directory, without you having to do
  43. anything.
  44.  
  45. If you do not subscribe to any *.binaries.* newsgroups, and receive no
  46. files via email, then this program has little or no use to you. However,
  47. anyone who has used the 'save' or 'uudecode' options in TTFN to get at the
  48. encoded files will see the huge advantages of this application immediately.
  49. (I Hope)
  50.  
  51. [Thankyous etc]
  52. There are two programs being distributed inside AutoUUD which I have
  53. altered slightly from their released forms. These are:
  54.  
  55. !UUExplode, ported by Martin Glanvill
  56. munpack 1.5, ported by Olly Betts
  57. Thankyou for writing them. I'd have been lost without your hard work.
  58. Also, A big thankyou to Graham Allan for all his help with Newsbase
  59.  
  60.  
  61. [Standard Disclamer]
  62. AutoUUD is FREEWARE, NOT PUBLIC DOMAIN OR SHAREWARE. That means that
  63. while you are free to distribute it freely, you may not make a profit
  64. from passing it on (PD Libraries may make a nominal charge to cover
  65. administration costs). I retain the copyright, and the 'borrowing' of
  66. any part of this application without my permission is prohibited.
  67.  
  68. While I am making every effort to make AutoUUD stable, I can make
  69. no guarantees, and therefore cannot be held responsible, that it
  70. will not cause data loss,hardware damage,etc.
  71.  
  72.  
  73. System Requirements
  74. -------------------
  75.  
  76. AutoUUD requires:
  77.   1)    Newsbase v0.55 (prerelease 12 or later)
  78.   2)    RiscOS 3.1
  79.   3)    1.5Mb+ of free memory
  80.  
  81. AutoUUD takes up a standard 640K when loaded, but you will need at *least*
  82. another 640K in the 'next' slot when you start to debatch. This means that
  83. 1Mb Machines are out of the question, and 2Mb is a squeeze.
  84.  
  85.  
  86. Installing AutoUUD
  87. ------------------
  88.  
  89. Thankfully, this version of AutoUUD does not need the hideous processes
  90. that AutoUUE had. All you have to do is copy it somewhere convenient,
  91. and make sure that the filer has 'seen' Newsbase before you load.
  92.  
  93.  
  94. Loading/Configuration
  95. ---------------------
  96.  
  97. Double click on the !AutoUUD icon :-)
  98.  
  99. AutoUUE will start Newsbase if it isn't loaded, and wait until it has
  100. sorted itself out. (This may take some time). You can now either click
  101. Adjust on the Iconbar, or select 'Config' from the menu.
  102.  
  103. (You *NEED* to configure the app before using it)
  104. A Description of the "AutoUD Configuration" window follows:
  105.  
  106.     Messages with Binaries
  107.     ----------------------
  108.     
  109.     Delete/Mark Read/Replace/Do Nothing
  110.     
  111.     Is it likely that AutoUUD will find some binaries when it scans
  112.     your messages. This section allows you to tell AUUD what to do
  113.     with the message after the file inside has been decoded.
  114.     
  115.     Delete is the recommended option, as this will remove the message,
  116.     saving disk space. It keeps the group listings in TTFN neat, and
  117.     managably small. The user (User:) must be able to delete articles.
  118.     
  119.     Mark Read is for those with obscene amounts of HD space. It will
  120.     tell TTFN that user (User:) has read the message, so it will show
  121.     up grey (or whatever colour) when you view the group listing.
  122.     --This will not stop AutoUUD from decoding it again though--
  123.     
  124.     Replace is a more complicated option for the short of HD space. It
  125.     will leave the message header intact, but replace the encoded file
  126.     with a message such as 'AutoUUD automatically extracted this file'
  127.     
  128.     Do Nothing will do exactly that. AutoUUD will not touch your news
  129.     database.
  130.     
  131.     Groups to Scan
  132.     --------------
  133.     
  134.     Clicking on the menu icon will bring up a list of newsgroups that
  135.     will be scanned. Select the ones which carry binaries.
  136.     
  137.     Delete one Line Messages
  138.     ------------------------
  139.     
  140.     This strictly speaking isn't part of AutoUUD's purpose, but is
  141.     intended as an added extra. It is basically a filter to wipe
  142.     any "ME TOO's","TESTING, IGNORE" and "SUBSCRIBE" messages that
  143.     really get on my nerves. I mean, *REALLY* get on my nerves.
  144.     
  145.     Log Process (DEBUG)
  146.     -------------------
  147.     
  148.     This is really for my use, to diagnose bugs. You want to leave
  149.     this alone.
  150.     
  151.     Default/Load/Save/OK
  152.     --------------------
  153.     
  154.     Use Default settings,Load saved settings,Save settings,Go with
  155.     these settings for the current session only.
  156.  
  157.  
  158. Debatching (AutoUUD in Use)
  159. ---------------------------
  160.  
  161. Click select on the iconbar, then on 'Start'. Sit back and wait.
  162.  
  163. On second thoughts, go and make your self a cup of tea.
  164. Or read a book.
  165. Like 'War and Peace'
  166. Slowly.
  167.  
  168. Alternatively, go on holiday.
  169. A Round the world cruise, for example.
  170.  
  171.  
  172. Slow? No, of course not! It's dead nippy, I tell you.
  173. Guv.
  174.  
  175.  
  176. Removing AutoUUD (Deinstallation)
  177. ---------------------------------
  178.  
  179. (Why you'd want to do this, I don't know, but it's better to be
  180. on the safe side)
  181.  
  182. As well as deleting !AutoUUD, you need to remove the directories
  183. '!NewsDir.autouud' and '!NewsDir.newsbase.config.autouud'
  184.  
  185.  
  186. Known Bugs/Limitations (FAQ)
  187. ----------------------------
  188.  
  189. Problem:  AutoUUD gets stuck while 'Receiving Articles'
  190. QuickFix: Stop debatching (Click 'Stop') and Index the group in Newsbase
  191. Reason:   NewsBase does not keep the overview file (which auud uses) up to
  192.       date. Indexing it will refresh it, and correct the problem.
  193.  
  194.  
  195. Problem:  I get complaints about 'AutoUUD cannot handle more than xxx
  196.       Groups/Users'
  197. QuickFix: Less Groups/Users, or edit the first line of the !RunImage file
  198. Reason:   Static Array Dimentions in BASIC. I really ought to think of a
  199.       better way of doing this.
  200.  
  201.  
  202. Problem:  Could not get all Article Info!
  203. QuickFix: Quit AutoUUD, reindex group, then try again
  204. Reason:   Newsbase has debatched articles since AutoUUD was loaded.
  205.  
  206.  
  207. Problem:  Some of the files that have been decoded are corrupt. Why?
  208. QuickFix: Beat up the sender ;-)
  209. Reason:   The main (only!) reason for this is people posting the messages
  210.       badly. Basically, they mucked it up, or it would have decoded
  211.       correctly. Politely tell the sender to SORT THEIR LIFE OUT.
  212.  
  213. History/Changes
  214. ---------------
  215.  
  216.    v0.01 Test run to see if it was possible
  217.    v0.02 First alpha-release (speed increase)
  218.    v0.03 Better handling of multi-part files
  219.    v0.10 <Rewrite> Proper front end,(slight speed increase)
  220.          Higher understanding, and it does not drop any (well posted)
  221.          binaries that could be decoded by hand with a newsreader
  222.          NB: (That it is coded to search for!)
  223.    v0.11 Handles more than 1000 messages in a friendly way now
  224.          Tidied up output files somewhat
  225.          When delete option set, it now writes News over the top of the
  226.           source file
  227.    v0.12 Format fully tidied up (as far as it will be)
  228.          Rudimentary support for auto-debatching in newsbase
  229.          Now manages more badly posted messages:
  230.          -- "LABLUE3.MID part 1/3" can now be understood.
  231.          -- (Part/Total at end, without brackets)
  232.  
  233.    v1.00 (alpha release) <REWRITE FROM SCRATCH>
  234.      First fully Desktop version. Multitasks in some places.
  235.      Acts as a client for Newsbase - Fully Implemented.
  236.      As a complete rewrite, some of the features of previous
  237.       versions are missing!
  238.  
  239.    v1.00 (beta release)
  240.          -- Fixed bug that stopped UUDecoding. Made it pretty useless.
  241.  
  242. Wish List/Future Updates
  243. ------------------------
  244.  
  245. * Base64/mime support for split binaries
  246. * Mark articles read option working
  247. * Anything else you care to tell me about.
  248.  
  249.  
  250. Contacting Me
  251. -------------
  252.  
  253. I am James Beech, and for the time being, can be reached as:
  254.  
  255. EMail: saint@nutters.dircon.co.uk
  256. BBS: User 'James Beech' (#486) on Digital Databank BBS (UK 01707 323531)
  257.  
  258. Phone: (01707 335047)
  259.  
  260. or SnailMail:    47 Brockswood Lane
  261.         Welwyn Garden City
  262.         Herts
  263.         AL8 7BE
  264.  
  265.  
  266. ATTN: GRAPHICS ARTISTS!
  267. -----------------------
  268.  
  269. You will have probably noticed, but I'm not exactly the worlds most
  270. talented artist. If you can come up with a better sprite for !AUUD,
  271. *PLEASE* mail it to me. I would be most grateful.
  272.